Encourage the use of markup files as documentation in enterprise [closed]

Posted by linquize on Programmers See other posts from Programmers or by linquize
Published on 2012-11-22T08:59:01Z Indexed on 2012/11/22 11:13 UTC
Read the original article Hit count: 301

Filed under:

version-control

|

documentation

|

documentation-generation

To make it eaiser to do version control and diff files of documentation, use markup files,

such as HTML: html/xhtml, XML: docbook, Wiki: markdown to replace doc/docx.

docx is too complex and lengthy.

For html, no extra document generation required. Programmers can write html directly and end users / managers can use any web browsers to view the document.

For custom XML or Wiki formats, viewers are required to view the document or converters are used to export to pdf/doc.

Is such move becoming popular in enterprise context? Why or why not?

© Programmers or respective owner

Related posts about version-control

In the context of the TFS version control SDK (Microsoft.TeamFoundation.VersionControl), what exactl

as seen on Stack Overflow - Search for 'Stack Overflow'
In the context of the TFS version control SDK (Microsoft.TeamFoundation.VersionControl), what exactly is deletionID? It is a property of Microsoft.TeamFoundation.VersionControl.Client.Item. It is also a parameter to some of the query methods on Microsoft.TeamFoundation.VersionControl.Client. I'm… >>> More
What are the advantages of version control systems that version each file separately?

as seen on Programmers - Search for 'Programmers'
Over the past few years I have worked with several different version control systems. For me, one of the fundamental differences between them has been whether they version files individually (each file has its own separate version numbering and history) or the repository as a whole (a "commit" or… >>> More
What are the advantages of version control systems that version each file separately?

as seen on Programmers - Search for 'Programmers'
Over the past few years I have worked with several different version control systems. For me, one of the fundamental differences between them has been whether they version files individually (each file has its own separate version numbering and history) or the repository as a whole (a "commit" or… >>> More
R and version control for the solo data analyst

as seen on Stack Overflow - Search for 'Stack Overflow'
Many data analysts that I respect use version control. For example: http://github.com/hadley/ See comments on http://permut.wordpress.com/2010/04/21/revision-control-statistics-bleg/ However, I'm evaluating whether adopting a version control system such as git would be worthwhile. A brief overview: I'm… >>> More
What version control tool can generate this header

as seen on Stack Overflow - Search for 'Stack Overflow'
This is from a sql script. What tool can generate this? Thanks --USE [MY_TABLE] GO /****** Object: StoredProcedure [dbo].[adminIncExp] Script Date: 03/05/2010 09:14:12 ******/ SET ANSI_NULLS ON GO SET QUOTED_IDENTIFIER ON GO -- ============================================= -- Author: … >>> More

Related posts about documentation

Hyperlinked, externalized source code documentation

as seen on Programmers - Search for 'Programmers'
Why do we still embed natural language descriptions of source code (i.e., the reason why a line of code was written) within the source code, rather than as a separate document? Given the expansive real-estate afforded to modern development environments (high-resolution monitors, dual-monitors, etc… >>> More
A tool to aid completion of missing or incomplete source code documentation

as seen on Stack Overflow - Search for 'Stack Overflow'
I have several finished, older PHP projects with a lot of includes that I would like to document in javadoc/phpDocumentor style. While working through each file manually and being forced to do a code review alongside the documenting would be the best thing, I am, simply out of time constraints,… >>> More
Quick C# Project Documentation in Visual Studio

as seen on Internet.com - Search for 'Internet.com'
Here's a quick way to document your .NET projects. >>> More
SQLAuthority News – Feature Pack for Microsoft SQL Server 2005 SP4

as seen on SQL Authority - Search for 'SQL Authority'
If you are still using SQL Server 2005 – I suggest that you consider migrating to later version of the SQL Server 2008/2008 R2. Due to any reason, you wanted to continue using SQL Server 2005, I suggest that you take a look at the Feature Pack for Microsoft SQL Server 2005 SP4. There are many… >>> More
SQLAuthority News – Statistics Used by the Query Optimizer in Microsoft SQL Server 2008 – Microsoft Whitepaper

as seen on SQL Authority - Search for 'SQL Authority'
I recently presented session on Statistics and Best Practices in Virtual Tech Days on Nov 22, 2010. The sessions was very popular and I got many questions right after the sessions. The number question I had received was where everybody can get the further information. I am very much happy that my… >>> More